home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / a_man / cat1 / clshmctl.z / clshmctl
Encoding:
Text File  |  2001-04-17  |  9.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. CCCCLLLLSSSSHHHHMMMMCCCCTTTTLLLL((((1111MMMM))))                                                      CCCCLLLLSSSSHHHHMMMMCCCCTTTTLLLL((((1111MMMM))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll - Administration tool for CrayLink Shared Memory
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_tttt_aaaa_rrrr_tttt_uuuu_pppp
  13.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_hhhh_uuuu_tttt_dddd_oooo_wwww_nnnn
  14.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _gggg_eeee_tttt_cccc_ffff_gggg
  15.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _mmmm_aaaa_xxxx_pppp_gggg_ssss <_nnnn_uuuu_mmmm _oooo_ffff _pppp_aaaa_gggg_eeee_ssss>
  16.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _mmmm_aaaa_xxxx_dddd_pppp_gggg_ssss <_nnnn_uuuu_mmmm _dddd_aaaa_eeee_mmmm _pppp_aaaa_gggg_eeee_ssss>
  17.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt <_dddd_aaaa_eeee_mmmm_oooo_nnnn _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt>
  18.  
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll is a system-administrator's tool for controlling the resources
  22.      associated with CrayLink-shared-memory (clshm) -- a means of cache-
  23.      coherent, shared-memory communication between partitions on an Origin-
  24.      2000.  Each partition of an Origin-2000 has its own hostname, IP address
  25.      and operating-system, and behaves as a stand-alone host.  clshm has a
  26.      system V shared memory interface in the form of a user library
  27.      (_xxxx_pppp______ffff_uuuu_nnnn_cccc(3p) and _pppp_aaaa_rrrr_tttt______ffff_uuuu_nnnn_cccc(3p)) that can be used directly by user-
  28.      applications.
  29.  
  30.  
  31.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll performs various functions needed to administer the software
  32.      devices and daemon associated with clshm and returns operational status
  33.      information.
  34.  
  35.  
  36.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll is invoked with one of the following function names, and the
  37.      associated parameters:
  38.  
  39.  
  40.      _ssss_tttt_aaaa_rrrr_tttt_uuuu_pppp     Configure clshm on the local partition, and start up the
  41.                  clshm devices and _cccc_llll_ssss_hhhh_mmmm_dddd(1m) daemon with default parameters.
  42.                  The value of the defaults can be examined by using the
  43.                  _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _gggg_eeee_tttt_cccc_ffff_gggg function, as explained later. The startup
  44.                  step is performed at system boot-up by _////_eeee_tttt_cccc_////_iiii_nnnn_iiii_tttt_...._dddd_////_ssss_nnnn_0000_ssss_tttt_aaaa_rrrr_tttt
  45.                  and is required before any inter-partition communication can
  46.                  be effected over CrayLink Shared Memory. This startup at
  47.                  bootup time must be enabled using the _cccc_hhhh_kkkk_cccc_oooo_nnnn_ffff_iiii_gggg(1m) command
  48.                  for _cccc_llll_ssss_hhhh_mmmm_dddd(1m).  It also needs to be done if clshm has been
  49.                  reset by a _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_hhhh_uuuu_tttt_dddd_oooo_wwww_nnnn command.  _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_tttt_aaaa_rrrr_tttt_uuuu_pppp also
  50.                  creates and initializes the software devices through which
  51.                  shared-memory communication is performed.
  52.  
  53.  
  54.      _ssss_hhhh_uuuu_tttt_dddd_oooo_wwww_nnnn    Forces a reset of the clshm software on the local partition.
  55.                  The _cccc_llll_ssss_hhhh_mmmm_dddd(1m) daemon is made to exit and the resources
  56.                  associated with the clshm software devices are released.
  57.                  _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_hhhh_uuuu_tttt_dddd_oooo_wwww_nnnn should be used carefully since any user-
  58.                  program using the clshm devices will be killed when this
  59.                  function is called.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCLLLLSSSSHHHHMMMMCCCCTTTTLLLL((((1111MMMM))))                                                      CCCCLLLLSSSSHHHHMMMMCCCCTTTTLLLL((((1111MMMM))))
  71.  
  72.  
  73.  
  74.      _gggg_eeee_tttt_cccc_ffff_gggg      Returns the configuration of clshm on the local partition.
  75.                  The parameters configurable through _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll are the maximum
  76.                  number of 16K pages of shared-memory that are supported, the
  77.                  number of 16K pages shared between the daemon and the kernel
  78.                  driver, and the timeout time before the _cccc_llll_ssss_hhhh_mmmm_dddd(1m) daemon
  79.                  wakes up from sleeping and checks for a message from the
  80.                  driver when there is no user activity going on.
  81.  
  82.  
  83.      _mmmm_aaaa_xxxx_pppp_gggg_ssss <_nnnn_uuuu_mmmm _oooo_ffff _pppp_aaaa_gggg_eeee_ssss>
  84.                  Sets the maximum number of pages of shared memory that can be
  85.                  associated with any of the channels on the local partition.
  86.                  _mmmm_aaaa_xxxx_pppp_gggg_ssss <_nnnn_uuuu_mmmm _oooo_ffff _pppp_aaaa_gggg_eeee_ssss> will fail if it is called after
  87.                  _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_tttt_aaaa_rrrr_tttt_uuuu_pppp has been called (without another _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll
  88.                  _ssss_hhhh_uuuu_tttt_dddd_oooo_wwww_nnnn).  In order to set this parameter, the _cccc_llll_ssss_hhhh_mmmm_dddd(1m)
  89.                  daemon must be in the shutdown state.
  90.  
  91.  
  92.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _mmmm_aaaa_xxxx_dddd_pppp_gggg_ssss <_nnnn_uuuu_mmmm _dddd_aaaa_eeee_mmmm _pppp_aaaa_gggg_eeee_ssss>
  93.                  Sets the maximum number of shared memory pages that the clshm
  94.                  driver can use to communicate with the _cccc_llll_ssss_hhhh_mmmm_dddd(1m) daemon.
  95.                  Like _mmmm_aaaa_xxxx_pppp_gggg_ssss, this call will fail if made after a _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll
  96.                  _ssss_tttt_aaaa_rrrr_tttt_uuuu_pppp call has been made.
  97.  
  98.  
  99.      _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt <_dddd_aaaa_eeee_mmmm_oooo_nnnn _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt>
  100.                  Sets the timeout value in milliseconds that the _cccc_llll_ssss_hhhh_mmmm_dddd(1m)
  101.                  daemon will sleep before checking for messages in the shared
  102.                  memory segment from the driver.  If there are messages coming
  103.                  in on either other daemon or user sockets, then the driver
  104.                  will not sleep the full amount of the timeout, but will
  105.                  process all messages if fines on all sockets and in the
  106.                  shared memory segment.
  107.  
  108.  
  109.  
  110. WWWWAAAARRRRNNNNIIIINNNNGGGGSSSS
  111.      If the _cccc_llll_ssss_hhhh_mmmm_dddd(1m) daemon aborts abnormally a _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_hhhh_uuuu_tttt_dddd_oooo_wwww_nnnn must be
  112.      called before a _cccc_llll_ssss_hhhh_mmmm_cccc_tttt_llll _ssss_tttt_aaaa_rrrr_tttt_uuuu_pppp can be called again to restart the
  113.      shared-memory mechanism.
  114.  
  115.  
  116. FFFFIIIILLLLEEEESSSS
  117.      _////_eeee_tttt_cccc_////_iiii_nnnn_iiii_tttt_...._dddd_////_ssss_nnnn_0000_ssss_tttt_aaaa_rrrr_tttt
  118.  
  119.  
  120. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  121.      _cccc_llll_ssss_hhhh_mmmm_dddd(1m), _cccc_hhhh_kkkk_cccc_oooo_nnnn_ffff_iiii_gggg(1m), _xxxx_pppp______ffff_uuuu_nnnn_cccc(3p), _pppp_aaaa_rrrr_tttt______ffff_uuuu_nnnn_cccc(3p), _cccc_llll_ssss_hhhh_mmmm______dddd_iiii_aaaa_gggg(1m),
  122.      _mmmm_kkkk_pppp_aaaa_rrrr_tttt(1m)
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.